home *** CD-ROM | disk | FTP | other *** search
/ Aminet 8 / Aminet 8 (1995)(GTI - Schatztruhe)[!][Oct 1995].iso / Aminet / comm / tcp / socklink100.lha / socklink / socklink.doc < prev    next >
Text File  |  1995-09-01  |  6KB  |  170 lines
  1. Document socklink.doc
  2.  
  3.  
  4.     ==============================================================
  5.     socklink 1.00 -- links stdio to socket (AmiTCP/IP and AS225r2)
  6.                             Documentation
  7.                         - September 1, 1995 -
  8.     ==============================================================
  9.  
  10.          Copyright (c) 1995 by Sam Yee.  All rights reserved.
  11.  
  12.  
  13. 1. Copyright and disclaimer
  14. ===========================
  15.  
  16. The  program,  socklink  and  its  associated  files  are  written and
  17. copyrighted  by  Sam  Yee.  It may be distributed freely providing the
  18. following conditions hold:
  19.  
  20. o Distributors may not charge more than the cost of a diskette used in
  21.   the distribution of this program.
  22.  
  23. o Distributors may only distribute the unmodified copy of the original
  24.   program, along with its documentation, and copyright notices intact.
  25.  
  26. o Commercial  distribution  is  only  possible with written permission
  27.   from the author.
  28.  
  29. This   program  and  its  documentation  are  provided  "as  is".   No
  30. warranties  are  made  with  respect  to  the  accuracy,  reliability,
  31. performance  or  operation  of this software and information.  You are
  32. using this program at your own risk.  The author is not liable for any
  33. damages that may have been caused by using this software.
  34.  
  35.  
  36. 2. Introduction
  37. ===============
  38.  
  39. socklink basically links the standard input/output (stdio) to a TCP/IP
  40. socket connected to a host.  It reads data from a socket, writes it to
  41. standard  output.  Conversely, it reads from standard input and writes
  42. to  the socket.  It handles data asynchronously and in both directions
  43. simultaneously.   No  data  translation  is  performed.   This  "pipe"
  44. enables  BBS  users,  who  lack  Internet access, to use serial device
  45. based network clients (such IRC clients) through an Internet-connected
  46. Amiga BBS.
  47.  
  48. socklink  runs  on  most modern BBSes capable of standard Command Line
  49. Interface (CLI) doors.  It supports AmiTCP, AS225r2, and MLINK.
  50.  
  51.  
  52. 3. Requirements
  53. ===============
  54.  
  55. socklink runs on any Amiga with version 2.04 of the OS, with AmiTCP or
  56. AS225r2 installed.  The BBS must also (obviously) have two phonelines,
  57. one  connected  to  the  net, and one for the BBS user.  socklink uses
  58. about 10K per line, or even less if it's made resident.
  59.  
  60.  
  61. 4. Installation
  62. ===============
  63.  
  64. The socklink archive contains the following files:
  65.  
  66. Makefile            - makefile for socklink.c
  67. RawIN.h             - header file for rawin.library
  68. rawin.library       - input/output handling library
  69. socklink.c          - C source to socklink
  70. socklink.doc        - socklink documentation in text format
  71. socklink.doc.info   - icon for above
  72. socklink.guide      - socklink documentation in AmigaGuide format
  73. socklink.guide.info - icon for above
  74. socklink_amitcp     - AmiTCP version of socklink
  75. socklink_as225      - AS225r2 version of socklink
  76. socklink_install    - Installer script
  77. socklink_install.info - icon for the above
  78.  
  79. If  you click on the installer script icon it should copy the files to
  80. the  appropriate  places.   If you like to install the files manually,
  81. you may do the following:
  82.  
  83. 4.1. AmiTCP manual installation
  84. -------------------------------
  85.  
  86.  1> cd ram:
  87.  1> lha x dh0: (or whatever the socklink archive is)
  88.  1> cd socklink
  89.  1> copy rawin.library libs: clone
  90.  1> copy socklink_amitcp AmiTCP:bin/socklink clone
  91.  1> copy socklink.(doc|guide)#? amitcp:doc/ clone
  92.  
  93. 4.2. AS225 manual installation
  94. ------------------------------
  95.  
  96.  1> cd ram:
  97.  1> lha x dh0: (or whatever the socklink archive is)
  98.  1> cd socklink
  99.  1> copy rawin.library libs: clone
  100.  1> copy socklink_as225 Inet:c/socklink clone
  101.  1> copy socklink.(doc|guide)#? Inet:docs/ clone
  102.  
  103. If  you  use MLINK and it's emulating AmiTCP, you should install the AmiTCP
  104. version.  Otherwise, install the AS225 version.
  105.  
  106.  
  107. 5. Using socklink
  108. =================
  109.  
  110. The command line usage for socklink is:
  111.     socklink <host> <port> [start-delay-seconds]
  112.  
  113.     where:
  114.         <host>  is the host you want to connect to,
  115.         <port>  is the port you want to connect to, and
  116.         [start-delay-seconds]  is  an optional argument specifying the
  117.                 number  of  seconds to delay before linking the socket
  118.                 to  stdio.   This  argument  is  here to give the user
  119.                 enough time to quit their terminal program and load up
  120.                 their  net  client.   Some  TCP  servers may send data
  121.                 immediately,  which would normally not give the client
  122.                 enough time to receive it.
  123.  
  124.     e.g., socklink irc-2.mit.edu 6667
  125.  
  126. socklink  is  not  BBS specific so it should run on most modern BBSes.
  127. No  BBS  specific  installation  is given here, but the following is a
  128. really simple procedure on how to set up socklink on your BBS.
  129.  
  130.  - Add socklink as a CLI door to your BBS menu:
  131.    e.g., "AmiTCP:bin/socklink irc-2.mit.edu 6667"
  132.  - Make the menu available to the user
  133.  
  134. To  start  socklink,  the  user  first logs onto the BBS with a normal
  135. terminal  program.  He/she then proceeds to launch socklink program by
  136. selecting a menu option.  socklink will attempt to connect to the host
  137. at  a  particular  port.  If a successful connection is made, the user
  138. quits the terminal program without dropping carrier and loads up a net
  139. client.  If the user wishes to quit socklink, they simply quit the net
  140. client,  reload their terminal program, and press ^C three times.  The
  141. user can of course drop carrier to disconnect altogether.
  142.  
  143.  
  144. 6. Acknowledgements
  145. ===================
  146.  
  147. Thank-you's go to...
  148.  
  149.  - Dan Fraser (IRC nick: Optic) for the initial idea and testing,
  150.  
  151.  - ??? (IRC nick: Azar) for testing, and
  152.  
  153.  - Robert Reiswig (IRC nick: RobR) for writing the Installer script.
  154.  
  155.  
  156. 7. Contact Address
  157. ==================
  158.  
  159. Questions,  ideas,  comments,  bug  reports, etc. should go to:
  160.  
  161. Snail Mail: Sam Yee
  162.             4595 Nanaimo St.
  163.             Vancouver, B.C.
  164.             Canada  V5N 5J5
  165.  
  166.   Internet: samy@sfu.ca (until Jan. 1., 1995)
  167.             samy@res.com
  168.             (IRC nick: Encoder in channel #amiga)
  169.    FidoNet: 1:153/765 (Terra Firma BBS (604) 434-3665)
  170.